/**
 * Copyright 1998-2007, CHISEL Group, University of Victoria, Victoria, BC, Canada.
 * All rights reserved.
 */
package ca.uvic.cs.cogz.mapping.ui.tree;

import javax.swing.tree.TreeNode;

/**
 * 
 * 
 * @author Chris Callendar
 */
public interface IFilteredTreeNode extends TreeNode {

	/**
	 * Returns the total number of children (this is how many children are shown when the filter is
	 * off).
	 * 
	 * @return
	 */
	public int getAllChildrenCount();

	/**
	 * Returns the number of children that are shown when the filter is applied.
	 */
	public int getFilterChildrenCount();

	/**
	 * Returns true if the filter is applied, false if all children are shown.
	 */
	public boolean isFiltered();

	public String getToolTipText();
}
